Expand some note and note expression doc #381
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The comments in free-audio#380 showed some places where our note and note expression doc had too much implicit knowledge. Try to address that with a few short paragraphs explainign the protocol
|
@baconpaul would you mind adding the changelog entry? |
|
Oh sure. Hold on. |
|
OK done! |
|
Thank you :) |
ohovers
reviewed
Jan 15, 2024
| enum { | ||
| // with 0 < x <= 4, plain = 20 * log(x) | ||
| CLAP_NOTE_EXPRESSION_VOLUME = 0, | ||
|
|
||
| // pan, 0 left, 0.5 center, 1 right | ||
| CLAP_NOTE_EXPRESSION_PAN = 1, | ||
|
|
||
| // relative tuning in semitone, from -120 to +120 | ||
| // relative tuning in semitone, from -120 to +120, in equal temperament |
There was a problem hiding this comment.
I would change "semitone" to "semitones". In English "in" + unit usually has the unit in plural. For example "in kilos", "in dollars".
The "in equal temperament" could be read to imply that only integer values are expected. Perhaps just note something like: "delta_in_cents = 100 * x". That should be clear enough, since a 12EDO semitone is 100 cents.
There was a problem hiding this comment.
Oh, I see it has already been merged. You can discard this comment then.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The comments in #380 showed some places where our note and note expression doc had too much implicit knowledge. Try to address that with a few short paragraphs explainign the protocol